130 MIDI Tool Box

home *** CD-ROM | disk | FTP | other *** search

/ 130 MIDI Tool Box / 130 MIDI Tool Box.iso / patchbak / pb.doc < prev next >

Wrap

Text File | 1989-04-06 | 20KB | 428 lines

PRESS <Esc> TO RETURN PATCHBAK MIDI Data Backup Utility Evaluation Copy Version D April 5, 1989 WHAT IS PATCHBAK? PatchBak is a software program that enables a PC with MIDI interface to send, receive, and store bulk MIDI System Exclusive dumps. Although dedi- cated MIDI disk drives are available for the same purpose, a PC offers many advantages over the single-function disk drive, including greater storage capacity and the ability to run sequencers and other software. PatchBak began as a simple program to back up a few cartridges of Casio CZ sounds using an IBM PC. However, the program quickly evolved into a generic package that could work with any piece of MIDI gear capable of initiating its own System Exclusive dump. PatchBak was written around the Music Quest MIDI Coprocessor Card (MCC). The MCC was chosen because of Music Quest's excellent hardware and software support. The MCC provides MPU-401 compatibility with a few features the 401 lacks. Equally important, Music Quest offers an MCC Programmer's Toolkit that simplifies writing custom software for the MCC and MPU-401. PatchBak's menu system is quite easy to master. A major goal of the menus has been to make the keystrokes intuitive and consistent throughout the program. At about one tenth the price of a MIDI disk drive, you'll find PatchBak a worthwhile addition to your PC and collection of MIDI software. PATCHBAK FEATURES o Stores and saves complete System Exclusive dumps, including dumps which contain many "End of Sys Ex" terminators (typical of Casio dumps). o Receive function handles non-SysEx signals that may also be present in the MIDI data stream. (Evaluation Version B and later versions). o Sends and receives System Exclusive dumps using all available PC memory, or up to about 200,000 MIDI characters into a PC with 640k. The actual maximum depends on your computer, your DOS, and other factors unique to your setup. o Overlay quick-select menus, with on-screen instructions. o Extensive error checking with understandable error messages. o Roland MPU-401 and Music Quest MCC compatibility. Works with all interrupts and addresses of the MCC. o PBSETUP program to customize hardware address and interrupt, screen colors, dumpsize, and other features. o Provides for an "accessory command" -- run a patch editor, librarian, or DOS command as an extension of PatchBak. o Toolkit functions show MIDI transmissions as hex bytes or MIDI events. SYSTEM REQUIREMENTS DOS: 3.0 or later Computer: PC, XT, AT, and 100% compatibles. Memory: 256k - 640k. Coprocessor chip: PatchBak does not require a math coprocessor chip, and will not benefit from a coprocessor. Disk drive: One 360k floppy drive, minimum. Dual floppies or fixed disk recommended. MIDI Interface: Developed for and tested with Music Quest MIDI Coprocessor Card. User reports confirm compatibility with Roland MPU-401. Character capacity: 262,000 character buffer. Actual capacity depends on system RAM, DOS version, DOS disk buffers, and other memory-resident software. Typical capacity with DOS 3.3 is about 200,000 characters Receive Speed: "386", AT, and 8MHz "Turbo" XT computers can receive sustained MIDI SysEx dumps at 3125 characters/second (the maximum MIDI spec) until memory is full. Actual transmission speed is controlled by the MIDI device. A 4.77MHz PC or XT computer will receive at least 32,767 MIDI characters at a sustained speed of 3125 characters per second, and about 58,000 characters typically. Transmissions of more than 58,000 bytes at maximum speed may overrun PatchBak's data buffer and result in data errors on a 4.77MHz. MIDI devices: Requires that the MIDI device be able to initiate a System Exclusive dump. PB uses no handshaking. Files: Evaluation version includes PB.EXE, PBSETUP.EXE, PB.DOC, and Microsoft library run-time file BRUN45.EXE. Evaluation version requires that BRUN45.EXE be on the same floppy disk, or in the same fixed disk directory as PB.EXE and PBSETUP.EXE for correct operation. ************************** * OPERATING INSTRUCTIONS * ************************** You can figure out most PatchBak menu items intuitively by reading the on- screen instructions and trying the function. The following instructions will help you get PatchBak set up, and will highlight the few operating points that are not immediately obvious. ****************** * KEYBOARD INPUT * ****************** The PB programs will prompt you for input from the computer keyboard three ways: 1. Menus require only that you enter the first letter of the menu choice. This letter is normally highlighted or a different color from the rest of the menu item. 2. "Point and toggle" is used to select from a range of preset values. It requires that you use the cursor control " " keys to move the on-screen pointer "" to the desired item, and the "+" or "-" keys to increase or decrease the value. Make changes and press <Enter> to select the choice. 3. Reverse video prompts require that you enter text or numeric data. The reverse video bar will accept the legal maximum of input characters. Type numbers or text and press <Enter>. Note: if you enter alpha characters where numbers are expected, PatchBak will interpret the alpha characters as 0. This may produce some unwanted results, but no damage will be done. The square bracket set "[]" in the on-screen instructions indicate optional items, such as "[drive:]" or "[.ext]". If you omit optional items, defaults will be used. The angle bracket set "<>" is used to indicate a keystroke, such as "<Enter>" or "<Esc>". Just press the key; don't type the quotes or brackets. Generally speaking, you can "back out" of any menu or function and return to the main menu by repeatedly pressing the Escape <Esc> key. In most cases, you can also answer prompts with <Esc> -- the entry operation will be aborted and the last valid entry will be retained. ****************** * ERROR MESSAGES * ****************** Illegal input or other error conditions will cause PatchBak to cycle through one or more error messages. If this occurs, don't be alarmed. Just press <Esc> after each error message until the error condition clears. Most error conditions are explained with detail sufficient to let you correct the error. Error notes also include an error number. If you want more information, these error numbers are referenced in most interpreter BASIC manuals or a Microsoft QuickBASIC manual. A very few error conditions return numbers but no explanation. These will normally not appear regardless of what's gone wrong. Status updates will appear in response to some operations. These will clear automatically after three seconds. You can erase them sooner by pressing <Esc>. PatchBak must be run from a non-write-protected diskette. If the diskette is write protected, you will receive an error message as soon as you run PatchBak. Quit, remove the write protection, and rerun. *********************** * MAKE A WORKING DISK * *********************** PatchBak can be operated from one or two floppy diskettes or a fixed disk. NOTE: These instructions assume that you have extracted the file PB_ARC.EXE to produce PB.EXE, PBSETUP.EXE, PB.DOC, and BRUN45.EXE. After you have done this, you will no longer need PB_ARC.EXE. o If you are running from a single floppy diskette, first boot from your DOS diskette. Make sure the DOS diskette contains FORMAT.COM, and then type the command "FORMAT A: /S". Insert a blank diskette in A: when prompted to do so. Next, copy PB.EXE, PBSETUP.EXE. PB.DOC, and BRUN45.EXE (but not PB_ARC.EXE) from your original diskette to the newly formatted working diskette. This will require some disk shuffling. Restart the computer with the new PatchBak working diskette in drive A:, and move to the section "RUN PBSETUP". o If you are running with dual floppy diskettes, first boot from your DOS diskette. Place a blank floppy diskette in Drive B:, and make sure the DOS diskette in A: contains FORMAT.COM. Type the command "FORMAT B: /S" to format the diskette in Drive B:. Next, place the disk containing the PatchBak files in Drive A:, and copy PB.EXE, PBSETUP.EXE, PB.DOC, and BRUN45.EXE (but not PB_ARC.EXE) to drive B:. Transfer the new PatchBak working diskette from Drive B: to Drive A: and reboot the computer. Move to the section "RUN PBSETUP". o If you are running from a fixed disk, copy PB.EXE, PBSETUP.EXE, PB.DOC, BRUN45.EXE to a fixed disk directory (a separate directory for PatchBak is suggested). Continue with the section "RUN PBSETUP". FIXED DISK USERS, NOTE: The DOS file COMMAND.COM must be accessible to PatchBak, either in the PatchBak directory, or through the PATH command in your AUTOEXEC.BAT file. *************** * RUN PBSETUP * *************** The "PBSETUP" program creates a configuration (.CNF) file which sets the per- sonality of the main PatchBak program. PBSETUP always searches for and loads the .CNF file if it exists. If no .CNF file is found, PBSETUP will generate a "default" setup which you can then modify to suit. When you quit PBSETUP, you will have a chance to check the information and change anything that isn't satisfactory. Avoid copying the .CNF file from to machine to machine because it contains information based on the computer where it was created. This information may not be valid on another machine. When and if you upgrade your version of PatchBak, you should delete the old .CNF file and run the new version of PBSETUP. To run Setup: ------------- 1. For floppy disk systems, boot the computer using the PatchBak working diskette. For fixed disk systems, ChDir to the directory containing the PatchBak files. 2. Type "PBSETUP" and press <Enter>. 3. Select each item in the Setup menu, and make changes as necessary. Refer to the following notes: MIDI ADDRESS and IRQ - suggested defaults for MCC and MPU-401 address and IRQ are 330 and 2. If you have set a Music Quest MCC for another address or interrupt, select the software address and IRQ to match. For other interfaces, consult the manufacturer's instructions for the address and interrupt. COLORS - follow the instructions at the bottom of the window. PBSETUP will automatically detect your type of video card (color or mono) and suggest a different color set accordingly. If you are using a color graphics adapter with composite monochrome monitor, set the colors to 7,7,15,0,0. SOUND - turns the attention beep on and off. If you are in an environment where beeps are undesirable, disable the beep. BYTES IN MIDI DUMP - sets the number of bytes that PatchBak expects in a MIDI dump. This number must equal or exceed the largest dump you expect to receive. Most dumps from non-sampling synths are less than 40,000 bytes. If you are not sure, use the maximum capacity shown. Later, you can run PatchBak and take sample dumps from your equipment. The PatchBak Main Menu "Update..." option will enable you to revise the dump size without rerunning PBSETUP. *ACCESSORY COMMAND - sets up the command or program that will be executed when you press "*" from within the PB Main Menu. Also accepts a description of the command which will be shown as the "*" menu choice in the PB Main Menu. The default accessory command is "Type PB.DOC" This will allow you to review the manual from within PatchBak. To execute other programs or DOS commands, simply type the name of the program or DOS command plus any command line modifiers which may be required. For example, the PatchBak manual can be read more conveniently with a utility program such as "BROWSE" which is included on the PC Magazine Utilities Disk. To use BROWSE, you would specify "BROWSE PB.DOC" as the accessory command. DRIVE/DIRECTORY FOR DATA - specifies where the data files will be stored. SETUP will use the current drive and directory by default. EXTENSION FOR DATA FILES - sets a common filename extension for data files. ".DAT" is the default, but you may enter any 1-3 letters that are appropriate for your data, for example: ".DX7", ".CZ1", ".D50", etc. QUIT AND SAVE - shows the selections, and provides a chance to save them or return to PBSETUP for changes. Also asks where you want the .CNF file to be written. PBSETUP will write the .CNF file to the current drive and directory unless you specify differently. This feature enables you to install the software to another "target" diskette or directory. **************** * RUN PATCHBAK * **************** Running the main PatchBak program is similar to running the PBSETUP program. Again, most functions are either obvious, or easy to figure out. The following notes touch upon the few functions that are not immediately obvious. To run PatchBak: ---------------- 1. For floppy disk systems, boot the computer using the PatchBak working diskette if you have not done so already. For fixed disk systems, ChDir to the directory containing the PatchBak files. 2. Type "PB" and press <Enter>. PatchBak will attempt to load the PBSETUP.CNF file, and then find a MIDI interface at the address and IRQ listed in the .CNF file. If a .CNF file is not found, you will be prompted to Quit, Continue, or run the PBSETUP program. If you select "Continue", PB will run with a default setup and assume the address 330 and interrupt 2 for the interface. If an interface is not found at 330 and 2, you will be prompted and asked whether to Continue or Quit. MAIN MENU --------- MIDI DATA - selects the receive, send, save, and load functions. TOOLKIT - selects the MIDI trace and MIDI THRU functions. *(ACCESSORY DESCRIPTION) - executes the command you have defined as the accessory command. The default accessory command will let you "type" the manual to the screen for on-line help. Just press "*", then use the <Pause> or <Ctrl NumLock> keys to stop, and to <spacebar> to resume the scrolling. DOS - temporarily leaves PatchBak and re-enters the DOS environment. Type "EXIT" at the DOS prompt to return to PatchBak. UPDATE SETUP FILE - revises PBSETUP.CNF with your most recent drive/ directory, datafile extension, and dumpsize. Answer "Y" or "N" to each of the prompts. If there was no .CNF file when you ran PatchBak, answering "Y" to any Update prompt will create a file with defaults for all parameters not covered in UPDATE. ABOUT PATCHBAK - Revision info, copyrights, and instructions for regis- tering as a PatchBak user. MIDI I/O MENU ------------- RECEIVE - enter the number of MIDI characters to be sent by the MIDI device. Alternately, you can use the maximum size shown by the MIDI I/O "Memory data" option. If the dump matches the expected number of bytes, PB will receive the dump and automatically return to the MIDI I/O MENU. If the dump is shorter than the number of bytes expected, wait a few seconds after the dump finishes, and press <Esc>. If the dump is longer than you expected, the message "MIDI device still sending!" will result. Increase the dumpsize and try again. Save data with the "W" option. SEND - first load a data file from disk with the "L" option, and then press "S" to send. You may also send back data that has been received via MIDI dump. => NOTE: The channel number is a part of the MIDI System Exclusive dump. Send data over the same channel used to receive it, or the MIDI device will not recognize the transmission. WRITE - saves the data in memory to disk. Press "W" and enter a filename for your data. The filename extension is optional; the indicated extension will be used unless you include one in your filename. If you include an extension, it will become the new default. If you need to check files, type ? <Enter> in place of the filename to run the Catalog. LOAD - copies data from a disk file into memory. Press "L" and enter the name of the file to be loaded. See the notes under "WRITE" concerning filenames and running the catalog. DISK/DIRECTORY CHANGE - selects a new disk drive or directory for loading and saving data files. CATALOG - lists files in the chosen DISK/DIRECTORY. You may specify your own search spec, such as *.DAT, *.*, etc. The default is "*." plus the current default filename extension. CATALOG can also be called up from the WRITE and LOAD prompts with ? <Enter>. MEMORY DATA - shows memory usage, and permits you to erase data in order to free up the MIDI data space. If an attempt to run DOS or your accessory command yields an "Out of Memory" error, first save your data, and then use MEMORY DATA ERASE to free up the memory. MCC TOOLKIT MENU HEX TRACE - shows the incoming MIDI stream as hex bytes. INTERPRETED HEX TRACE - translates incoming MIDI stream into verbal descriptions of MIDI events. ENABLE MIDI THRU - turns on the MCC's "MIDI THRU" feature. Data entering the MIDI IN port will be routed to the MIDI OUT port. DISABLE MIDI THRU - turns off the MCC's "MIDI THRU". Data entering the MIDI IN port will not be routed to the MIDI OUT port. => NOTE: The last two functions are useful for experimenting with the effects of self-triggering MIDI sounds. PatchBak normally defaults to the DISABLED state, and will revert to DISABLE after any MIDI I/O functions. REGISTER YOUR COPY - If you're completely satisfied with how PatchBak works with your MIDI gear and want to support the product, a donation of $25.00 (or ?) would be cheerfully accepted. $49.00 will get you PatchBak Version 2.10 which includes several enhancements not found in the evaluation. Specifically, its .EXE files don't need the BRUN45.EXE run-time support file, so take less total disk space. The menus work a bit more smoothly. Active Sense (FE) is now detected by Interpreted Trace. Send $49.00 payable to: Guy Zumpetta c/o MIDIware 10945 Diagonal Road Mantua, OH 44255 Please specify 5-1/4" or 3-1/2" diskette, otherwise 5-1/4" will be sent. PRESS <Esc> TO RETURN